

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction &mdash; NLP Architect by Intel® AI Lab 0.5.2 documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../../../../../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../../../../" src="../../../../../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
        <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
        <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
        <script type="text/javascript" src="../../../../../_static/language_data.js"></script>
        <script type="text/javascript" src="../../../../../_static/install.js"></script>
        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    
    <script type="text/javascript" src="../../../../../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../../../../_static/nlp_arch_theme.css" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto+Mono" type="text/css" />
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:100,900" type="text/css" />
    <link rel="index" title="Index" href="../../../../../genindex.html" />
    <link rel="search" title="Search" href="../../../../../search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../../../../../index.html">
          

          
            
            <img src="../../../../../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../quick_start.html">Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../publications.html">Publications</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../tutorials.html">Jupyter Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../model_zoo.html">Model Zoo</a></li>
</ul>
<p class="caption"><span class="caption-text">NLP/NLU Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../tagging/sequence_tagging.html">Sequence Tagging</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../sentiment.html">Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../bist_parser.html">Dependency Parsing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../intent.html">Intent Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../lm.html">Language Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../information_extraction.html">Information Extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../transformers.html">Transformers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../archived/additional.html">Additional Models</a></li>
</ul>
<p class="caption"><span class="caption-text">Optimized Models</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../quantized_bert.html">Quantized BERT</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../transformers_distillation.html">Transformers Distillation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../sparse_gnmt.html">Sparse Neural Machine Translation</a></li>
</ul>
<p class="caption"><span class="caption-text">Solutions</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../absa_solution.html">Aspect Based Sentiment Analysis</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../term_set_expansion.html">Set Expansion</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../trend_analysis.html">Trend Analysis</a></li>
</ul>
<p class="caption"><span class="caption-text">For Developers</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../generated_api/nlp_architect_api_index.html">nlp_architect API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../developer_guide.html">Developer Guide</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../../../index.html">NLP Architect by Intel® AI Lab</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../../../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../../../../index.html">Module code</a> &raquo;</li>
        
      <li>nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <h1>Source code for nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction</h1><div class="highlight"><pre>
<span></span><span class="c1"># ******************************************************************************</span>
<span class="c1"># Copyright 2017-2018 Intel Corporation</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class="c1"># you may not use this file except in compliance with the License.</span>
<span class="c1"># You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1">#     http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="c1"># ******************************************************************************</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Set</span>

<span class="kn">from</span> <span class="nn">nlp_architect.common.cdc.mention_data</span> <span class="kn">import</span> <span class="n">MentionData</span>
<span class="kn">from</span> <span class="nn">nlp_architect.data.cdc_resources.relations.relation_extraction</span> <span class="kn">import</span> <span class="n">RelationExtraction</span>
<span class="kn">from</span> <span class="nn">nlp_architect.data.cdc_resources.relations.relation_types_enums</span> <span class="kn">import</span> <span class="n">RelationType</span>
<span class="kn">from</span> <span class="nn">nlp_architect.utils.io</span> <span class="kn">import</span> <span class="n">load_json_file</span>

<span class="n">logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>


<div class="viewcode-block" id="WithinDocCoref"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.relations.html#nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction.WithinDocCoref">[docs]</a><span class="k">class</span> <span class="nc">WithinDocCoref</span><span class="p">(</span><span class="n">RelationExtraction</span><span class="p">):</span>
    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wd_file</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Extract Relation between two mentions according to Within document co-reference</span>

<span class="sd">        Args:</span>
<span class="sd">            wd_file (required): str Location of within doc co-reference mentions file</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">&quot;Loading Within doc resource&quot;</span><span class="p">)</span>
        <span class="k">if</span> <span class="n">wd_file</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">wd_file</span><span class="p">):</span>
            <span class="n">wd_mentions_json</span> <span class="o">=</span> <span class="n">load_json_file</span><span class="p">(</span><span class="n">wd_file</span><span class="p">)</span>
            <span class="bp">self</span><span class="o">.</span><span class="n">within_doc_coref_chain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">arrange_resource</span><span class="p">(</span><span class="n">wd_mentions_json</span><span class="p">)</span>
        <span class="k">else</span><span class="p">:</span>
            <span class="k">raise</span> <span class="ne">FileNotFoundError</span><span class="p">(</span><span class="s2">&quot;Within-doc resource file not found or not in path&quot;</span><span class="p">)</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">WithinDocCoref</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>

<div class="viewcode-block" id="WithinDocCoref.arrange_resource"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.relations.html#nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction.WithinDocCoref.arrange_resource">[docs]</a>    <span class="nd">@staticmethod</span>
    <span class="k">def</span> <span class="nf">arrange_resource</span><span class="p">(</span><span class="n">wd_mentions_json</span><span class="p">):</span>
        <span class="n">document_tokens_dict</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
        <span class="k">for</span> <span class="n">mention_json</span> <span class="ow">in</span> <span class="n">wd_mentions_json</span><span class="p">:</span>
            <span class="n">mention_data</span> <span class="o">=</span> <span class="n">MentionData</span><span class="o">.</span><span class="n">read_json_mention_data_line</span><span class="p">(</span><span class="n">mention_json</span><span class="p">)</span>
            <span class="n">mention_tokens</span> <span class="o">=</span> <span class="n">mention_data</span><span class="o">.</span><span class="n">tokens_number</span>
            <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="nb">len</span><span class="p">(</span><span class="n">mention_tokens</span><span class="p">)):</span>
                <span class="n">doc_id</span> <span class="o">=</span> <span class="n">mention_data</span><span class="o">.</span><span class="n">doc_id</span>
                <span class="n">sent_id</span> <span class="o">=</span> <span class="n">mention_data</span><span class="o">.</span><span class="n">sent_id</span>
                <span class="n">token_map_key</span> <span class="o">=</span> <span class="n">MentionData</span><span class="o">.</span><span class="n">static_gen_token_unique_id</span><span class="p">(</span>
                    <span class="n">doc_id</span><span class="p">,</span> <span class="n">sent_id</span><span class="p">,</span> <span class="n">mention_tokens</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
                <span class="p">)</span>
                <span class="n">document_tokens_dict</span><span class="p">[</span><span class="n">token_map_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">mention_data</span><span class="o">.</span><span class="n">coref_chain</span>
        <span class="k">return</span> <span class="n">document_tokens_dict</span></div>

<div class="viewcode-block" id="WithinDocCoref.extract_all_relations"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.relations.html#nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction.WithinDocCoref.extract_all_relations">[docs]</a>    <span class="k">def</span> <span class="nf">extract_all_relations</span><span class="p">(</span>
        <span class="bp">self</span><span class="p">,</span> <span class="n">mention_x</span><span class="p">:</span> <span class="n">MentionData</span><span class="p">,</span> <span class="n">mention_y</span><span class="p">:</span> <span class="n">MentionData</span>
    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Set</span><span class="p">[</span><span class="n">RelationType</span><span class="p">]:</span>
        <span class="n">ret_</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
        <span class="n">ret_</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extract_sub_relations</span><span class="p">(</span><span class="n">mention_x</span><span class="p">,</span> <span class="n">mention_y</span><span class="p">,</span> <span class="n">RelationType</span><span class="o">.</span><span class="n">WITHIN_DOC_COREF</span><span class="p">))</span>
        <span class="k">return</span> <span class="n">ret_</span></div>

<div class="viewcode-block" id="WithinDocCoref.extract_sub_relations"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.relations.html#nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction.WithinDocCoref.extract_sub_relations">[docs]</a>    <span class="k">def</span> <span class="nf">extract_sub_relations</span><span class="p">(</span>
        <span class="bp">self</span><span class="p">,</span> <span class="n">mention_x</span><span class="p">:</span> <span class="n">MentionData</span><span class="p">,</span> <span class="n">mention_y</span><span class="p">:</span> <span class="n">MentionData</span><span class="p">,</span> <span class="n">relation</span><span class="p">:</span> <span class="n">RelationType</span>
    <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">RelationType</span><span class="p">:</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Check if input mentions has the given relation between them</span>

<span class="sd">        Args:</span>
<span class="sd">            mention_x: MentionDataLight</span>
<span class="sd">            mention_y: MentionDataLight</span>
<span class="sd">            relation: RelationType</span>

<span class="sd">        Returns:</span>
<span class="sd">            RelationType: relation in case mentions has given relation or</span>
<span class="sd">                RelationType.NO_RELATION_FOUND otherwise</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">if</span> <span class="n">relation</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">RelationType</span><span class="o">.</span><span class="n">WITHIN_DOC_COREF</span><span class="p">:</span>
            <span class="k">return</span> <span class="n">RelationType</span><span class="o">.</span><span class="n">NO_RELATION_FOUND</span>

        <span class="k">if</span> <span class="n">mention_x</span><span class="o">.</span><span class="n">doc_id</span> <span class="o">==</span> <span class="n">mention_y</span><span class="o">.</span><span class="n">doc_id</span><span class="p">:</span>
            <span class="n">ment_x_coref_chain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extract_within_coref</span><span class="p">(</span><span class="n">mention_x</span><span class="p">)</span>
            <span class="n">ment_y_coref_chain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">extract_within_coref</span><span class="p">(</span><span class="n">mention_y</span><span class="p">)</span>

            <span class="k">if</span> <span class="ow">not</span> <span class="n">ment_x_coref_chain</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">ment_y_coref_chain</span><span class="p">:</span>
                <span class="k">return</span> <span class="n">RelationType</span><span class="o">.</span><span class="n">NO_RELATION_FOUND</span>

            <span class="k">if</span> <span class="s2">&quot;-&quot;</span> <span class="ow">in</span> <span class="n">ment_x_coref_chain</span> <span class="ow">or</span> <span class="s2">&quot;-&quot;</span> <span class="ow">in</span> <span class="n">ment_y_coref_chain</span><span class="p">:</span>
                <span class="k">return</span> <span class="n">RelationType</span><span class="o">.</span><span class="n">NO_RELATION_FOUND</span>

            <span class="k">if</span> <span class="nb">set</span><span class="p">(</span><span class="n">ment_x_coref_chain</span><span class="p">)</span> <span class="o">==</span> <span class="nb">set</span><span class="p">(</span><span class="n">ment_y_coref_chain</span><span class="p">):</span>
                <span class="k">return</span> <span class="n">RelationType</span><span class="o">.</span><span class="n">WITHIN_DOC_COREF</span>

        <span class="k">return</span> <span class="n">RelationType</span><span class="o">.</span><span class="n">NO_RELATION_FOUND</span></div>

<div class="viewcode-block" id="WithinDocCoref.extract_within_coref"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.relations.html#nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction.WithinDocCoref.extract_within_coref">[docs]</a>    <span class="k">def</span> <span class="nf">extract_within_coref</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mention</span><span class="p">:</span> <span class="n">MentionData</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
        <span class="n">tokens</span> <span class="o">=</span> <span class="n">mention</span><span class="o">.</span><span class="n">tokens_number</span>
        <span class="n">within_coref_token</span> <span class="o">=</span> <span class="p">[]</span>
        <span class="k">for</span> <span class="n">token_id</span> <span class="ow">in</span> <span class="n">tokens</span><span class="p">:</span>
            <span class="n">token_x_id</span> <span class="o">=</span> <span class="n">MentionData</span><span class="o">.</span><span class="n">static_gen_token_unique_id</span><span class="p">(</span>
                <span class="nb">str</span><span class="p">(</span><span class="n">mention</span><span class="o">.</span><span class="n">doc_id</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">mention</span><span class="o">.</span><span class="n">sent_id</span><span class="p">),</span> <span class="nb">str</span><span class="p">(</span><span class="n">token_id</span><span class="p">)</span>
            <span class="p">)</span>
            <span class="k">if</span> <span class="n">token_x_id</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">within_doc_coref_chain</span><span class="p">:</span>
                <span class="n">token_coref_chain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">within_doc_coref_chain</span><span class="p">[</span><span class="n">token_x_id</span><span class="p">]</span>
                <span class="k">if</span> <span class="n">token_coref_chain</span><span class="p">:</span>
                    <span class="n">within_coref_token</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">token_coref_chain</span><span class="p">)</span>
            <span class="k">else</span><span class="p">:</span>
                <span class="n">within_coref_token</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;-&quot;</span><span class="p">)</span>
                <span class="k">break</span>

        <span class="k">return</span> <span class="n">within_coref_token</span></div>

<div class="viewcode-block" id="WithinDocCoref.get_within_doc_coref_chain"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.relations.html#nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction.WithinDocCoref.get_within_doc_coref_chain">[docs]</a>    <span class="k">def</span> <span class="nf">get_within_doc_coref_chain</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">within_doc_coref_chain</span></div>

<div class="viewcode-block" id="WithinDocCoref.create_ment_id"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.relations.html#nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction.WithinDocCoref.create_ment_id">[docs]</a>    <span class="nd">@staticmethod</span>
    <span class="k">def</span> <span class="nf">create_ment_id</span><span class="p">(</span><span class="n">mention_x</span><span class="p">:</span> <span class="n">MentionData</span><span class="p">,</span> <span class="n">mention_y</span><span class="p">:</span> <span class="n">MentionData</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
        <span class="k">return</span> <span class="s2">&quot;_&quot;</span><span class="o">.</span><span class="n">join</span><span class="p">([</span><span class="n">mention_x</span><span class="o">.</span><span class="n">get_mention_id</span><span class="p">(),</span> <span class="n">mention_y</span><span class="o">.</span><span class="n">get_mention_id</span><span class="p">()])</span></div>

<div class="viewcode-block" id="WithinDocCoref.get_supported_relations"><a class="viewcode-back" href="../../../../../generated_api/nlp_architect.data.cdc_resources.relations.html#nlp_architect.data.cdc_resources.relations.within_doc_coref_extraction.WithinDocCoref.get_supported_relations">[docs]</a>    <span class="nd">@staticmethod</span>
    <span class="k">def</span> <span class="nf">get_supported_relations</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="n">RelationType</span><span class="p">]:</span>
        <span class="sd">&quot;&quot;&quot;</span>
<span class="sd">        Return all supported relations by this class</span>

<span class="sd">        Returns:</span>
<span class="sd">            List[RelationType]</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="k">return</span> <span class="p">[</span><span class="n">RelationType</span><span class="o">.</span><span class="n">WITHIN_DOC_COREF</span><span class="p">]</span></div></div>
</pre></div>

           </div>
           
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>